Skip to main content

describeEip

Description

Describe eip.

Request Method

GET

Request Path

/customer/eip/describe

Request Parameters Common Parameters

NameLocationTypeRequiredSample valueDescription
instanceIdQueryStringYesNo sample value for this parameter. instance id
regionIdQueryStringYesNo sample value for this parameter. region id

Return data

NameTypeSample valueDescription
resultobject`{"chargingMethod":"PayByTraffic","bandwidth":1.0,"instanceName":"eipName1","billingMethod":"PayAsYouGo","instanceType":"","ipAddress":"147.139.180.243","expiredTime":2.177423999E+12,"instanceId":"eip-k1antagnd9sj9nkf2pha6","regionId":"id-jakarta-sigma-p01","createTime":1.668568792E+12,"lineType":"BGP","networkType":"Public","status":"Available"}`information of result
resultCodestring0result code
resultMsgstringsuccessresult message

Example

Successful Response example

{
"result":
{
"chargingMethod":"PayByTraffic",
"bandwidth":1.0,
"instanceName":"eipName1",
"billingMethod":"PayAsYouGo",
"instanceType":"",
"ipAddress":"147.139.180.243",
"expiredTime":2.177423999E+12,
"instanceId":"eip-k1antagnd9sj9nkf2pha6",
"regionId":"id-jakarta-sigma-p01",
"createTime":1.668568792E+12,
"lineType":"BGP",
"networkType":"Public",
"status":"Available"
},
"resultCode":"0",
"resultMsg":"success"
}

Failed Response example

{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}

}